Package-level declarations

Types

Link copied to clipboard
data class Capabilities(val supportsPurchase: Boolean = true, val supportsRefund: Boolean = true, val supportsReservations: Boolean, val supportsCapture: Boolean, val supportsReservationAdjustment: Boolean, val supportsReservationCancellation: Boolean = false, val supportsReversal: Boolean = false, val supportsBatchProcess: Boolean = false, val supportsFinalBalance: Boolean = false, val supportsLastPaymentResult: Boolean = false, val supportsTerminalStatus: Boolean = false, val supportsReceiptReprint: Boolean = false, val supportsCardIdentification: Boolean, val apiVersion: String? = null, val runtimeVersion: String? = null, val supportsDeviceActivation: Boolean = false, val supportsConfiguration: Boolean = false, val supportsInitialisation: Boolean = false)

Terminal capability flags.

Link copied to clipboard
interface ConfigApi

Terminal API configuration, capability, and status operations.

Link copied to clipboard
data class ConfigurationResult @JvmOverloads constructor(val outcome: RequestOutcome = RequestOutcome.SUCCESSFUL, val errorReason: ErrorReason? = null)

Final business outcome of SI(CONFIG) terminal configuration download without acquirer initialization.

Link copied to clipboard
data class DeviceActivationResult @JvmOverloads constructor(val outcome: RequestOutcome = RequestOutcome.SUCCESSFUL, val errorReason: ErrorReason? = null)

Final business outcome of device activation.

Link copied to clipboard
data class InitialisationResult @JvmOverloads constructor(val outcome: RequestOutcome = RequestOutcome.SUCCESSFUL, val errorReason: ErrorReason? = null)

Final business outcome of standalone SI(INIT) acquirer initialization.

Link copied to clipboard
data class TerminalInfo(val terminalId: String, val serialNumber: String? = null, val merchantId: String? = null, val merchantName: String? = null, val spaceId: String? = null, val acquirerId: String? = null, val acquirerName: String? = null)

Configured terminal identity and optional device, portal, acquirer, and merchant information.

Link copied to clipboard
data class TerminalStatus @JvmOverloads constructor(val status: TerminalStatusValue, val rawStatus: String = status.name)

Current terminal status.

Link copied to clipboard

Recognized terminal operation states.

Functions

Link copied to clipboard

Awaits the final device activation business outcome, including USER_ERROR with an error reason. An already activated device throws a non-retryable INVALID_REQUEST terminal exception. Setup readiness or busy rejection occurs before the activation code reaches the backend.

Link copied to clipboard

Awaits the SI(CONFIG) business outcome, including USER_ERROR; does not run acquirer initialization. A setup readiness or busy rejection throws a terminal exception before dispatch.

Link copied to clipboard

Awaits the final SI(INIT) business outcome, including USER_ERROR with an error reason. A setup readiness or busy rejection throws a terminal exception before dispatch.

Link copied to clipboard

Awaits the terminal capability snapshot.

Link copied to clipboard

Awaits the configured terminal identity snapshot.

Link copied to clipboard

Awaits the current terminal status snapshot.